Class FileScanner

Summary

Fully Qualified Name: Laminas\Code\Scanner\FileScanner
Extends: TokenArrayScanner
Implements: ScannerInterface

Description

Methods

Name Description Defined By
__construct() FileScanner
__toString() TokenArrayScanner
export() Export TokenArrayScanner
getAnnotationManager() TokenArrayScanner
getClass() Return the class object from this scanner TokenArrayScanner
getClassNameInformation() TokenArrayScanner
getClassNames() TokenArrayScanner
getClasses() TokenArrayScanner
getDocComment() Get doc comment TokenArrayScanner
getFile() FileScanner
getFunctionNames() TokenArrayScanner
getFunctions() TokenArrayScanner
getIncludes() TokenArrayScanner
getNamespaces() TokenArrayScanner
getUses() TokenArrayScanner
hasNamespace() Check for namespace TokenArrayScanner

Method Details

__construct()

Parameter Name Type Description
$file string
$annotationManager null|\AnnotationManager

Returns:

__toString()

Returns: void

export()

Export

Parameter Name Type Description
$tokens mixed

Returns:

getAnnotationManager()

Returns: \AnnotationManager

getClass()

Return the class object from this scanner

Parameter Name Type Description
$name string|int

Returns: \ClassScanner|bool

getClassNameInformation()

Parameter Name Type Description
$className string

Returns: bool|null|\NameInformation

getClassNames()

Returns: array

getClasses()

Returns: \ClassScanner[]

getDocComment()

Get doc comment

Returns: string|null

getFile()

Returns: string

getFunctionNames()

Returns: array

getFunctions()

Returns: array

getIncludes()

Returns: void

getNamespaces()

Returns: array

getUses()

Parameter Name Type Description
$namespace null|string

Returns: array|null

hasNamespace()

Check for namespace

Parameter Name Type Description
$namespace string

Returns: bool

Top